home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / comm / commo54.zip / ADDENDUM.DOC next >
Text File  |  1992-12-19  |  18KB  |  508 lines

  1.  
  2.  
  3.  
  4.                             {COMMO} 5.4 Addendum
  5.                             ____________________
  6.  
  7.      This Addendum contains the major additions and/or changes to the
  8.      {COMMO} 5.3 documentation.  Print out this file and keep it with
  9.      your printed manual.  There is a complete list of changes (major
  10.      and minor) in the file HISTORY.
  11.  
  12.  
  13.      ===============================
  14.      In the User Guide and Reference
  15.      ===============================
  16.  
  17.      Setup File changes/additions
  18.      ----------------------------
  19.  
  20.      ______________________________________________________
  21.  
  22.      {cdm=yes}      Clear dialing marks at startup (yes/no)
  23.      ______________________________________________________
  24.  
  25.           If this is "yes", {COMMO} will clear all dialing marks in
  26.           the Dialing Directory when you start the program.  Set it to
  27.           "no" if you want to retain dialing marks from the previous
  28.           session.  Note that the marks are normally saved with the
  29.           Dialing Directory file whenever it is written to disk.
  30.  
  31.      ____________________________________________________
  32.  
  33.      {avm=}         Alternate video mode (mode,rows,cols)
  34.      ____________________________________________________
  35.  
  36.           You can toggle between two hardware video modes (text modes
  37.           only) if this item is defined.  One important application
  38.           for this is the 132 column feature in VT102 emulation .  It
  39.           can also be used to toggle between any two different video
  40.           modes using the VIDEo macro function.
  41.  
  42.           The "normal" video mode is the mode that is in effect when
  43.           {COMMO} is started.  That mode will always be restored
  44.           automatically when you exit the program (but not in the
  45.           Shell to DOS).
  46.  
  47.           The mode field must be expressed as a hexadecimal number,
  48.           while the rows and columns are decimal numbers (minimum
  49.           dimensions are 25x80).  As an example, suppose that your
  50.           video adapter uses mode 23h (hexadecimal) to support a
  51.           25x132 screen.  Then you would write this item as:
  52.  
  53.                {avm=23,25,132}     Alternate video mode
  54.  
  55.           Note that some "modes" are not hardware modes and cannot be
  56.           toggled using this feature.  These include the 50 line mode
  57.           supported by VGA adapters or the 43 line mode supported by
  58.  
  59.  
  60.  
  61.           EGA adapters.  Consult your video adapter manual for a list
  62.           of hardware modes supported (or contact the manufacturer).
  63.  
  64.      _____________________________________________________
  65.  
  66.      {edi=yes}      Startup editor in insert mode (yes/no)
  67.      _____________________________________________________
  68.  
  69.           Set this to "yes" if you want insert mode turned on the
  70.           first time you start the Internal Editor.  This also applies
  71.           to the input field editor.
  72.  
  73.      __________________________________________________
  74.  
  75.      {kts=07,17}    Terminal Screen, Status Line colors
  76.      __________________________________________________
  77.  
  78.           For the most accurate ANSI-BBS or VT102 terminal emulation,
  79.           the Terminal Screen colors should be set to 07.  In many
  80.           cases, {COMMO} uses this color when clearing portions of the
  81.           screen or when a "reset attributes" sequence is received
  82.           from the host.
  83.  
  84.      ____________________________________________________
  85.  
  86.      {kdd=1e,70,4f}      Dialing Directory window colors
  87.      {kmf=1e,70,4f}      Macro File window colors
  88.      {ksb=03,70,4f}      Scrollback window colors
  89.      {khf=1e,70}         Online Help file window colors
  90.      {kee=1e,70}         Edit external file window colors
  91.      {kvs=1e,70}         Variable Space window colors
  92.      ____________________________________________________
  93.  
  94.           These are the "file" window colors.  The three parameters
  95.           are the text, titles and selector bar, respectively.  Note
  96.           that some of the windows do not have a selector bar.
  97.  
  98.      ______________________________________________________
  99.  
  100.      {kcf=70,17}         Capture File Options window colors
  101.      {ksi=70,17}         Screen Image file window colors
  102.      {kdw=03,47}         Dialer window colors
  103.      {kau=70,17}         ASCII Upload window colors
  104.      {kpw=70,17}         Protocol window colors
  105.      {kid=70,17}         Input data window colors
  106.      {kst=70,17}         Set Toggles window colors
  107.      {ktp=70,17}         Terminal Parameters window colors
  108.      {kep=70,17}         Execute Preview window colors
  109.      {kmw=4f,6f}         Message window colors
  110.      {set _mcolor,70,17}      Macro Menu colors
  111.      ______________________________________________________
  112.  
  113.           These are the "pop-up" window colors.  The two parameters
  114.           are the text and border, respectively.  The "Macro Menu"
  115.           colors are the initial colors to be used on menus created
  116.  
  117.  
  118.  
  119.           with the MENU macro function.  These may be changed at any
  120.           time by redefining the variable "_mcolor".
  121.  
  122.           Colors should be set so that the different parts of the
  123.           screen contrast with each other.  For example the Status
  124.           Line should be easily discernable from the rest of the
  125.           Terminal Screen.  And the borders and Selector Bar should
  126.           stand out against the text portion of the file windows.
  127.  
  128.  
  129.      Under "Uploading/Downloading"
  130.      -----------------------------
  131.  
  132.      ASCII Upload/Download
  133.      =====================
  134.  
  135.      Text files may be sent and received using the ASCII protocol. 
  136.      This method performs no error checking or error correction and
  137.      should only be used when other protocols are not available.
  138.  
  139.      It might be used, for example, to upload a prepared message to a
  140.      host that was waiting for you to type the message.  Or it could
  141.      be used to receive a bulletin or other information that you would
  142.      normally read while on line.
  143.  
  144.      To upload a text file, use the Alt-A key command.  See "Alt-A 
  145.      ASCII Upload."
  146.  
  147.      To download text information to a file, use {COMMO}'s Capture
  148.      File feature.  Use the Alt-1 key command to set the filename and
  149.      Capture Mode.  Open the Capture File just prior to receiving the
  150.      information.  Then close it after all data has been received. 
  151.      Note that the file may require some editing.  See "Alt-1  Capture
  152.      File Options."
  153.  
  154.  
  155.  
  156.      ==============================
  157.      In the Macro Programming Guide
  158.      ==============================
  159.  
  160.      ------------------------------------
  161.      New or changed function descriptions
  162.      ------------------------------------
  163.  
  164.      _____
  165.  
  166.      BREAk
  167.      _____
  168.  
  169.      Default key:   Alt-B
  170.      Description:   Send a break.
  171.  
  172.      Switches:
  173.  
  174.                Tn             Set break duration in system clock
  175.                               ticks.  "n" may range from 1 to 999. 
  176.                               There are 18.2 clock ticks per second.
  177.  
  178.                T0 or T        Set break duration to 18 clock ticks
  179.                               (default).
  180.  
  181.      Examples:
  182.  
  183.           {break}             One second break.
  184.           {break-t9}          One-half second break.
  185.           {break-t55}         Three second break.
  186.  
  187.      ________
  188.  
  189.      KEYStuff
  190.      ________
  191.  
  192.      Default key:   none
  193.      Description:   Put key codes into the keyboard buffer.
  194.  
  195.      Examples:
  196.  
  197.           {keys 1c0d}         Put a carriage return into the keyboard
  198.                               buffer.
  199.  
  200.           {keys 1e41,6c00}    Put an "A" in the keyboard buffer
  201.                               followed by Alt-F5.
  202.  
  203.      This function is usually used prior to EXECuting programs, batch
  204.      files or DOS commands that require keys to be pressed.  It allows
  205.      complete automation without operator intervention.
  206.  
  207.  
  208.  
  209.      TIPS on using KEYStuff:
  210.  
  211.      >    The key codes are given in hexadecimal (scan code/character
  212.           code as received from the BIOS).  Press Alt-K in the
  213.           Internal Editor to view any key code.
  214.  
  215.      >    One or more codes may be listed.  Do not insert extra
  216.           spaces.
  217.  
  218.      >    Usually, when specifying an ASCII character, only the
  219.           character code need be listed.  Thus the second example
  220.           above could be written:  {keys 41,6c00}.
  221.  
  222.      _______
  223.  
  224.      LOOKfor
  225.      _______
  226.  
  227.      Default key:   none
  228.      Description:   Look for strings in the modem input stream.
  229.  
  230.      LOOKfor is used in conjunction with SSLOok, CALOok and GOLOok to
  231.      scan for as many as 16 strings at the same time.  When SSLOok,
  232.      CALOok and GOLOok set up additional strings to look for, the
  233.      actual "looking" does not take place until the LOOKfor executes.
  234.  
  235.      Parameters controlling LOOKfor are set with the SETLook function
  236.      and may be changed at any time with another SETLook.  See the
  237.      description of the SETLook function for details.
  238.  
  239.      Examples using LOOKfor only:
  240.  
  241.           {lookfor first name?}    Look for the string "first name?"
  242.  
  243.           {look ^(COMMO^)}         Look for the string "{COMMO}".
  244.  
  245.           When the string comes in, control will pass to the next
  246.           function.
  247.  
  248.      Example construct using SSLOok/CALOok/GOLOok/LOOKfor:
  249.  
  250.                     {setlook 60,hng,3,n|}
  251.                     {setv ss_r,|}
  252.                       ...
  253.           {:start}
  254.                     {golook label-a,target1}
  255.                     {calook start,label-b,target2}
  256.                     {sslook ss_r,target3}
  257.                     {golook ,target4}
  258.                     {lookfor target5} {send answer5} {goto label-c}
  259.  
  260.           {:label-a}     {hangup y} {goto cancel}
  261.           {:label-b}     {send answer2} {call subr} {return}
  262.           {:label-c}          ...
  263.  
  264.  
  265.  
  266.           In this example {COMMO} will look for five target strings.
  267.  
  268.           When a target specified in any of the CALOok, GOLOok or
  269.           LOOKfor functions is received, the LOOKfor is cancelled.  It
  270.           may be set up again by going to "start".
  271.  
  272.           When the target specified in the SSLOok is received, the
  273.           string in the variable will be transmitted to the serial
  274.           port.  The LOOKfor will continue to look for the same
  275.           targets.
  276.  
  277.           The GOLOok function for target1 will GOTO "label-a" when the
  278.           string comes in.  In the example control will pass to
  279.           "cancel" (macro not shown).
  280.  
  281.           If target2 comes in, the CALOok function will set "start" as
  282.           the return point and then CALL "label-b".  When this routine
  283.           RETUrns, control returns to "start" and the five string
  284.           LOOKfor will be set up again.
  285.  
  286.           If target3 is received, the string in the variable "ss_r"
  287.           will be sent (in this case, a carriage return) and looking
  288.           will continue.
  289.  
  290.           The GOLOok for target4 has a null label and control will
  291.           pass to the function following the LOOKfor if that string
  292.           comes in.  The "," must be present.
  293.  
  294.           If target5 comes in, control will pass to the function
  295.           following the LOOKfor.
  296.  
  297.      TIPS on creating LOOKfor strings:
  298.  
  299.      >    There should be just one space following the LOOKfor
  300.           function name.  Any spaces beyond this point are part of the
  301.           string.  The string ends at the right curly brace.
  302.  
  303.      >    SSLOok/CALOok/GOLOok/Auto Receive strings begin immediately
  304.           after the comma.  There should be no spaces unless they are
  305.           part of the string.
  306.  
  307.      >    Strings may be up to 32 characters in length (control
  308.           characters like "^M" count as one).  Upper/lower case is
  309.           ignored.
  310.  
  311.      >    ANSI control sequences are filtered if ANSI or VT102
  312.           emulation is enabled.
  313.  
  314.      >    Remember that short strings may not be unique enough, long
  315.           strings may not match due to line noise.
  316.  
  317.      >    Rules for representing special characters in
  318.           SSLOok/CALOok/GOLOok/LOOKfor/Auto Receive strings are given
  319.           in Appendix D in the User Guide and Reference.
  320.  
  321.  
  322.  
  323.      Additional TIPS:
  324.  
  325.      >    SSLOok, CALOok and GOLOok functions should immediately
  326.           precede a LOOKfor (no string compares actually occur until
  327.           the LOOKfor executes).  Up to 15 SSLOok/CALOok/GOLOok
  328.           strings may be used in addition to the LOOKfor (up to 16
  329.           strings total).
  330.  
  331.      >    FILTER Capture Mode should be used to determine the exact
  332.           prompt to look for.  The LOOKfor sees the incoming data
  333.           exactly as it is captured when FILTER mode is set.
  334.  
  335.      >    If two or more strings cause a match at the same time, the
  336.           LAST such string listed is the one acted upon (for example,
  337.           if "abcdef" and "def" are listed and the string "abcdef"
  338.           comes in).
  339.  
  340.      See also: SSLOok, CALOok, GOLOok, SETLook.
  341.  
  342.      ____
  343.  
  344.      MENU
  345.      ____
  346.  
  347.      Default key:   none
  348.      Description:   Create a pop-up macro menu.
  349.  
  350.      General form:
  351.  
  352.           {MENU height,width,string}
  353.  
  354.                height         Total number of rows from top to bottom
  355.                               of pop-up window, including borders. 
  356.                               Minimum is 5.
  357.  
  358.                width          Total number of columns from left side
  359.                               to right side, including borders. 
  360.                               Minimum is 23.
  361.  
  362.                string         Title string that will appear in the top
  363.                               border.
  364.  
  365.      Example:
  366.  
  367.           {setv _menu1, F1  Call computer at work}
  368.           {setv _menu3, F2  Call E-mail service}
  369.           {setv _menu5, F3  Run offline mail reader}
  370.           {setv _mlabel,work,mail,reader}
  371.           {setv _mcolor,17,30}
  372.           {menu 9,32,Daily Activity Menu} {}
  373.  
  374.      The MENU function can be used to select macros for execution from
  375.      a pop-up window.  Parameters are defined using reserved variables
  376.      and the arguments shown in the general form above.
  377.  
  378.  
  379.  
  380.      Variables are used to define a string for each displayable line
  381.      in the interior of the window.  "_menu1" is the first line,
  382.      "_menu2" is the second, and so on (total number of definable
  383.      lines is "height" less 4).  Lines in the window for which no
  384.      variable has been defined will be left blank.
  385.  
  386.      The variable "_mlabel" is used to define a list of macro labels. 
  387.      {COMMO} will GOTO a label if the respective function key, number
  388.      key or letter key is pressed.  For example, the macro at the
  389.      third label in the list will execute if F3, 3 or C is pressed. 
  390.      Keys supported are: F1 to F12 (first 12 labels), A to Z (first 26
  391.      labels) and 1 to 9 (first 9 labels).
  392.  
  393.      The variable "_mcolor" is used to define the text and border
  394.      colors of the pop-up window.  The attributes are specified in the
  395.      same manner as the colors in the Setup File (press F7 in the
  396.      Internal Editor to display the Color Chart).  
  397.  
  398.      TIPS on using MENU:
  399.  
  400.      >    The dimensions of the window are limited by the current size
  401.           of the Terminal Screen.
  402.  
  403.      >    All variables used to create the menu are automatically
  404.           deleted from Variable Space after the menu is displayed.
  405.  
  406.      >    The last colors used to display a menu will persist until
  407.           they are changed by setting the "_mcolor" variable.
  408.  
  409.      >    If Esc is pressed to exit the menu, macro processing
  410.           continues in sequence following the MENU function.
  411.  
  412.      See also MACRo.
  413.  
  414.      ______
  415.  
  416.      OFFLog
  417.      ______
  418.  
  419.      Default key:   none
  420.      Description:   Make an {Off} entry in the Usage Log.
  421.  
  422.      Example:
  423.  
  424.           {offlog}            No arguments.
  425.  
  426.      This function is useful on systems that do not support the
  427.      carrier detect signal.
  428.  
  429.  
  430.  
  431.      ______
  432.  
  433.      SSLOok
  434.      ______
  435.  
  436.      Default key:   none
  437.      Description:   Set up an additional string to look for during a
  438.                     subsequent LOOKfor function.
  439.  
  440.      General form:
  441.  
  442.           {SSLOok name,target}
  443.  
  444.                name      The name of a string variable (MUST be a
  445.                          variable).
  446.  
  447.                target    The ASCII string to look for.  The string
  448.                          begins following the "," and is terminated by
  449.                          the "}".
  450.  
  451.      Example:
  452.  
  453.           {setv ss_r,|} {setv ss_nr,n|}
  454.           ...
  455.           {sslo ss_r,Press enter to continue}
  456.           {sslo ss_nr,Do you want to log off?}
  457.           {look command?} ...
  458.  
  459.      SSLOok is used in conjunction with LOOKfor.  When the target
  460.      string appears, the string in the variable is sent to the serial
  461.      port.  The LOOKfor continues to look for all specified strings.
  462.  
  463.      See LOOKfor for details, examples and tips on using SSLOok.
  464.  
  465.      See also: CALOok, GOLOok, SETLook.
  466.  
  467.      _____
  468.  
  469.      VIDEo
  470.      _____
  471.  
  472.      Default key:   none
  473.      Description:   Change to an alternate hardware video mode.
  474.  
  475.      Switches:
  476.  
  477.                M1 or M   Change to the alternate display mode.
  478.                M0        Change back to the normal display mode.
  479.  
  480.      Examples:
  481.  
  482.           {video-m1}          Change to the alternate mode.
  483.           {video-m0}          Change back to the normal mode.
  484.  
  485.  
  486.  
  487.      The "alternate" mode is defined by Setup File item {avm=}.  The
  488.      "normal" mode is the mode in effect when you start {COMMO}.
  489.  
  490.  
  491.      New variables
  492.      -------------
  493.  
  494.           _menux         Menu display string, x = 1, 2, 3, etc.
  495.           _mlabel        List of macro labels for pop-up menu 
  496.           _mcolor        Colors used with pop-up menus: text, border
  497.  
  498.           _dfc      Disk full on capture: 0=no, 1=yes; reset when
  499.                     Capture File is opened, set when disk is full
  500.  
  501.           _pad      Current serial port address: 03F8, 02E8, etc.
  502.           _irq      Current IRQ number: 4, 3, etc.
  503.           _fmt      Current data format: 8n1, 7e1, etc.
  504.  
  505.  
  506.                                   - end -
  507.  
  508.